home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / fido / SHELTER275.lha / DOCS / XPACK.doc < prev    next >
Text File  |  1995-04-19  |  13KB  |  300 lines
  1. $VER: Xpack DOC XfreqQ Management Tools  Williamson 2.75
  2.  
  3.     A collection of useful tools for XfreQ management by Robert Williamson.
  4.  
  5.     Xpack       -   5D echomail archiver/router/queuer/scheduler    *
  6.     Xq          -   FLO convert, scan outs, Xpack front-end
  7.     XList       -   lists queue for a site, a pattern or all sites  *
  8.     Xkill       -   remove a filepattern from a sitepattern         *
  9.     Xfix        -   re-queues mail files using Addwork
  10.     Xrmv        -   remove a file from a site queue
  11.     AddWork     -   add a file to a site queue, aware of filetypes
  12.     SendFile    -   a simple version of AddWork
  13.     Xflo        -   online flo conversion
  14.     Xcut        -   online .CUT scan and send
  15.     
  16.     Please  note  that  tools  marked  with  a  * require the WB2 Arexx DOS
  17. support library rexxdossupport.library.
  18.  
  19.  
  20.  
  21.     XPACK
  22.         Xpack  archives  5D echomail OUT files and queues and schedules the
  23. archives for transmission.  It is designed to work with any Shelter mailer.
  24. If  RexxDosSupport.library  is not available, XPack will require the mailer
  25. to  be ACTIVE in order to operate.  It will use the ROOFLOG functionhost if
  26. it is available.
  27.  
  28.         There  are  presently  very few tossers which produce 5D OUT files,
  29. Gordon  and  Roof being the only two I know of myself.  In order to provide
  30. an  upgrade  path  to  others,  I  have  included  the utility XQ.rexx as a
  31. frontend to Xpack.
  32.  
  33.     Installation:
  34.         Archivers  are  expected  to  be  either resident or on the current
  35. path.
  36.  
  37.         ClipList Variables:
  38.         The following arexx clipvars are expected to be set:
  39.             DOMAIN                  - the default domain (eg: FIDONET)
  40.             HOST.ADDRESS.<domain>   - 4d address in each domain
  41.      *      POINTNET                - your pointnet,if you are the BOSS
  42.             REXXDIR                 - path to ROOF/SHELTER rexx scripts
  43.             OUTDIR                  - where 5D OUT files are found, 
  44.                                       and arcmail archives are placed
  45.      *      PKMDIR                  - temporary work path,
  46.                                       will be created by Xpack
  47.      *      PKTDIR                  - outbound for packets
  48.                                       will be created by Xpack
  49.             SCREEN                  - public screen on which to open
  50.                                       Xpack window
  51.             FLODIR                  - where *.?LO files are found,
  52.                                       in a secure system, this should NOT
  53.                                       be OUTDIR.
  54.  
  55.         With  Shelter  Mailers, you will have to set the clipvars indicated
  56. "*"  yourself.   Note  that  PKTDIR should be set to your FLODIR.  A simple
  57. AmigaDOS  script,  in  the format:  RxSet variablename value, should do the
  58. trick.
  59.  
  60.  
  61.     Xpack:
  62.     The XPACK.CFG is expected to be found in the CFG: volume.
  63.     Each  address  is customized to the targets preferred archiving method,
  64. mail flavour, poll command and poll windows for mail pickup/delivery, freqs
  65. etc.   For  example  'PollMGR sched 1:167/90.0' might invoked from the POLL
  66. script  if un-able to connect during the Cron-invoked window.  Refer to the
  67. sample for more information.
  68.  
  69.     Compression  types  supported are ARC, LHA, LZH, ZIP, NON (none).  This
  70. defaults to LHA NORM.
  71.  
  72.     Mail Types Supported:  LOCAL, CRASH, HOLD, DIRECT, NORMAL
  73.  
  74.         LOCAL   will not be called and should not have any windows.
  75.                 a  command  may be specified to move or import with a
  76.                 point package
  77.  
  78.         HOLD    will  not  be  called  and  should  not  have any poll
  79.                 command or poll windows defined.
  80.  
  81.         NORM    mail  will  be  SCHEDULED  using poll command and poll
  82.                 windows
  83.  
  84.         CRASH   will  be called immediately and rescheduled using poll
  85.                 command and poll windows
  86.  
  87.          A poll window time of '*' indicates immediate redial
  88.         (ie dial until connect)
  89.  
  90.  'cmd'  should be either the AmigaDOS script POLL or a script specific to a
  91. particular node.
  92.  
  93.     Scheduling  requires  the ROOF FLOWMGR Function host, so when a Shelter
  94. Mailer  is used, the poll window, and cmd options are not available and the
  95. command SHELTER POLL is used instead.
  96.  
  97.     Xpack Usage:
  98.         Xpack               - will scan defined outbound directory
  99.         Xpack outfilename   - processes specified ?U(T|0-9) file
  100.         Xpack pattern       - processes ?U(T|0-9) files matching pattern
  101.  
  102.     FileName Features:
  103.  
  104.         4D OUT - zone.net.node.point.(O|C|D|H|N|L)U(T|(0-9))
  105.         4D FLO - zone.net.node.point.(F|C|D|H|N|L)LO
  106.         5D OUT - domain.zone.net.node.point.(O|C|D|H|N|L)U(T|(0-9))
  107.         5D ARCMAIL - domain.zone.net.node.point.(MO|TU|WE|TH|FR|SA|SU)(0-9)
  108.  
  109.     -   Xpack handles LOCAL OUT files
  110.     -   Xpack is able to handle multiple ?U(T|0-9) files for same address.  
  111.     -   ?UT  files  are  renamed to FTS packets before archiving.
  112.     -   Transmitted ARCMAIL filename is always based upon our address in
  113.         the target domain.  Xpack is the only Amiga packer that follows the
  114.         ARCmail specification in this regard.
  115.  
  116.  
  117.     Xpack  is based upon PackMgr.rexx by Robert Williamson, which was Based
  118. on  Jbundle  &  Jbun2  by James Mcormond and FidoInOut by Russell McOrmond.
  119. This version is for xferq.library 1.9+ and WPL Mailers v0.97+
  120.  
  121.  
  122.     XQ
  123.         Does the following operations:
  124.         - queue files listed in 4D *.?LO files in FLODIR, 
  125.           .?LO files are then deleted
  126.             queued ?UT files are moved to OUTDIR/f,
  127.             all others remain in OUTDIR
  128.             no filename conversion is done on these
  129.         - rename 4D *.?UT files in OUTDIR to 5D
  130.             These should NOT be files that are already listed
  131.             in processed .FLO files
  132.         - call XPACK to route, archive .OUT files and queue 
  133.         - queue any remaining 5D *.DUT, *.CUT, *.HUT, *.NUT files
  134.             any remaining *.OUT files will be ignored unless the internal
  135.             flag 'q_outs; is set to 1.  Normally, .OUT files are ECHOMAIL
  136.             pending archiving, netmail being never put in .OUT files..
  137.             Unfortunately, a number of 'modern' tossers/point packages have
  138.             chosen to ignore this convention.
  139.     XQ:
  140.         usage:
  141.         Xpack Clean/S,NoCVT/S,No4D/S,Xpack/S,Qouts/S,NoDeleteTIC/S,PktCvt/S,Debug/S
  142.  
  143.         The  following lines found at the beginning of the script should be
  144. editied  to  suit  your  setup.  The first is a list of FTN domain names in
  145. which you are active and the zones they use.
  146.  
  147.  dl="FIDONET  1  FIDONET 2 FIDONET 3 FIDONET 4 FIDONET 5 FIDONET 6 AMIGANET
  148. 38 AMIGANET 39 AMIGANET 40 CJNET 100 FRANCOMEDIA 101 MTLNET 17"
  149.     
  150.    Clean       do a cleanup of non-existing files
  151.    NoCVT       FLO to Queue conversion will not be done
  152.    Xpack       Xpack will be called to process 5D EchoMail OUT files
  153.    Qouts       Queue OUT files remaining after XPACK
  154.    NoDeleteTIC TIC will not be forced to delete after send
  155.    No4D        4d to 5d filename conversion not done
  156.    PktCvt      Packet is converted from 4D FTS1 to 5D FSC39
  157.         The last two are mutually exclusive, that is one cannot set No4D
  158.         and PktCvt.
  159.  
  160.    eg: Xq xpack Qouts NoDeleteTIC Debug
  161.        would eanble xpack, queue outs, no set tic to delete, debug on
  162.             
  163.     Other utils:
  164.  
  165.     ADDWORK
  166.         Adds a file to a site queue, allowing the setting of disposition,
  167.         priority and queue control.  If file is *.?UT then it will be sent
  168.         as a *.PKT.  If file is ARCmail, an ARCmail sendas name will be
  169.         created.  Both default to disposition=D (delete) and priority 50
  170.         (crash).
  171.  
  172.         ADDWORK site_address fullname disposition priority queuectl
  173.  
  174.         A partial address may be given.  It will be expanded based upon the
  175.         address variables listed below.
  176.  
  177.         disposition: D=delete if sent
  178.                      T=truncate if sent to zero bytes
  179.                      L=do nothing    (default)
  180.                 
  181.         priority:    (-128 to +128)  (default 50)
  182.  
  183.         queuectl:    I=queue only if connected to site
  184.                        if set to delete, it IS deleted even if not sent  
  185.                      K=queue only if connected to site,
  186.                        if set to delete, if it NOT deleted if not sent  
  187.                      A=queue after current session with site
  188.                      default is none
  189.  
  190.     This utility requires the following clipvars to be set:
  191.  
  192.         DOMAIN                  - default domain
  193.         HOST.ADDRESS.<domain>   - address in each domain
  194.  
  195.     If DOMAIN is not set, HOST.address.<domain> will be assumed unset also.
  196. In this case, XFERQ:hostaddr will be use to set these two variables.
  197.  
  198.         SCREEN                  - public screen name
  199.      *  POINTNET                - PointNet number
  200.                                   This is the net, (eg: 30730) not a point's
  201.                                   FakeNet address (eg: 30730/2)
  202.         DOMAINLIST              - list of domains and zones
  203.  
  204.     These are all set in both the ROOF System and the Shelter Mailers. 
  205.  
  206.  
  207.     SENDFILE 5Daddress file [sendas] [disposition]
  208.         Adds  a  file to the site queue.  If not specified, Disposition is
  209.         set to Leave. Valid dispositions are:
  210.              D - delete after send
  211.              L - leave the file (default)
  212.         Priority is always Crash.  
  213.         Filename sent (SendAs) is the filename without the path unless
  214.         otherwise specified..
  215.  
  216.     XRMV 5Daddress file   
  217.         Remove a file from a site queue.
  218.         address  must be complete for the network type, 
  219.         file must be the fullpathname as listed in site queue
  220.         
  221.     XKILL site_pattern file_pattern
  222.         This allows one to remove all files matching the file_pattern from
  223.         all sites matching the site_pattern.  Requires
  224.         RexxDosSupport.library
  225.  
  226.     XLIST
  227.         Xlist
  228.             with no  arguments,  lists  all  sites,
  229.             and the files, asnames, priorities and dispositions for each.
  230.         Xlist #?104.#?
  231.             if an amigados pattern is given, only matching sites are listed
  232.         Xlist fidonet#1:167/151.0
  233.             if  a  full  address  is  given,  nothing will be listed due to
  234.             pattern  matching, use Xlist fidonet#?1:167/151.0 instead.
  235.  
  236.         format of list is:
  237.                                     sitename
  238.         fullname                    asname  priority queuectl dispostion
  239.  
  240.         priority    -50     = HOLD
  241.                     0-30    = NORM
  242.                     30-50   = DIRECT
  243.                     50->    = CRASH
  244.                     120     = INTRANSIT
  245.  
  246.         queuectl    I   immediate, is queued for current session,
  247.                         it will be deleted regardless if it is sent or not,
  248.                         IF it is alos set to delete. 
  249.                     A   sendlater, file is queued for the next session
  250.                         with the online site.
  251.                     K   keep, file is queued for current session (I), 
  252.                         but will not be deleted if it is not sent
  253.                         IF set to Delete.
  254.  
  255.         dispostion  L   Leave, files will be untouched after sending
  256.                     T   Truncate,  file  will  be truncated to 0 bytes after
  257.                         sending
  258.                     D   Delete, file will be deleted after sending
  259.  
  260.  
  261.     XFIX [DIRECT] 5dHostAddress
  262.         Requeues  4D  and  5d  files  using  Addwork.   If DIRECT option is
  263.         specified,  all  files  will be queued for the address indicated by
  264.         the  filename.   Otherwise,  all  file for one's own points will be
  265.         routed to the points primary address defined by 5dHostAddress.
  266.  
  267.     XFLO OutboundDir 5dHostAddress 5dRemoteAddressList
  268.         XFLO  can  called when connected to a site.  It is somewhat similar
  269.         in  operation to an Xferq Freq Handler.  It scans for FLO files for
  270.         the site and adds listed files to the site queue in IMMEDIATE mode,
  271.         according  to  the  priorities derived from the filenames.  It also
  272.         scans for ?UT files and queues these also.  Asnames are created for
  273.         both 4D ARcMail and .?UT files.
  274.  
  275.         It is called BEFORE session handshake negotiation as:
  276.         SYSTEM "RX XFLO $(OUTBOUND) $(HOST.ADDRESS) $(CALLED)"
  277.         $(CALLED) can be either a single address or an AKA list in WPL
  278.         address format.  The standard WPL address format for FTN is:
  279.         "domain#zone:net/node.point".
  280.  
  281.         Since this utility is intended for dial-only points, any files with
  282.         a priority of HOLD are changed to NORMAL.
  283.         An internal switch allows DISABLING sending of .OUT files.
  284.  
  285.         An even smaller version which only accepts a single remote address,
  286.         jaz.f or rap.f, is used with the JAZ and RAP mailers.
  287.  
  288.     XCUT OutboundDir 5dRemoteAddress
  289.         Similar to XFLO, this one only scans for a CUT packet for the
  290.         address specified.  It would be used by a wpl mailer system that
  291.         does not have a XferqQ utility to scan for CRASH mail.
  292.  
  293.         It is called BEFORE session handshake negotiation as:
  294.         SYSTEM "RX XCUT $(OUTBOUND) $(CALLED)"
  295.         $(REMOTE.ADDRESS) camn be used instead of $(CALLED).  The standard
  296.         WPL address format for FTN is:
  297.                 "domain#zone:net/node.point"
  298.  
  299.  
  300.